package com.zlq.cn.config;

public class Apidoc {
    /**
     * @apiDefine createAndUpdateTime
     * @apiSuccess {String} createTime 创建时间
     * @apiSuccess {String} updateTime 更新时间
     */
    /**
     * @api {POST} /api/user/login 用户登录
     * @apiName 用户登录
     * @apiGroup 用户
     * @apiParam {String} phone 手机号码
     * @apiParam {String} vcode=1234 验证码
     * @apiParam {String} platform 平台
     * @apiParamExample {json} Request-Example:
     *     {
     *       "phone": "12345678947",
     *       "vcode": "1234",
     *       "platform": "1234"
     *     }
     * @apiUse userInfoSuccess
     */

    /**
     * @apiDefine userInfoSuccess
     * @apiSuccess {Int} id
     * @apiSuccess {String} name 昵称
     * @apiSuccess {String} phone 手机号码
     * @apiSuccess {String} avatar 头像
     * @apiSuccess {String} gender 性别 未知：UNKNOWN（默认值）；男：MAN；女：WOMAN
     * @apiSuccess {String} token token
     * @apiSuccess {String} phoneModel 手机型号
     * @apiSuccess {String} membershipExpirationDate 会员到期时间
     * @apiSuccess {String} invitationCode 邀请码
     * @apiSuccess {String} friendNum 好友数量
     * @apiSuccess {String="4G","WIFI","5G"} networkType 网络类型；4G / WIFI / 5G
     * @apiSuccess {String} battery 电量
     * @apiSuccess {String} isOnline 是否在线
     * @apiSuccess {String} isDisable 是否禁用
     * @apiSuccess {String} isNotVipAddFriend 非VIP是否允许添加好友
     * @apiSuccess {String} vipLevel vip等级
     * @apiSuccess {String} vipStartTime vip开始时间
     * @apiSuccess {String} vipEndTime vip结束时间
     * @apiSuccess {Integer} surplusDay 剩余时长
     * @apiSuccess {Integer} locationResetCount 清除次数
     * @apiSuccess {String} createTime 创建时间
     * @apiSuccess {String} updateTime 更新时间
     * @apiSuccess {String} currentDate 当前时间
     * @apiSuccessExample {json} 成功示例:
     * {
     * "id": 17,
     * "name": "17620410531",
     * "phone": "17620410531",
     * "avatar": "https://thirtyfairy.oss-cn-shenzhen.aliyuncs.com/icon_default_avatar.jpg",
     * "token": "6467e0c788b24f3f92437f1b73e9c9f8",
     * "isDisable": 0,
     * "vipLevel": 0,
     * "vipStartTime": "2020-06-10 09:18:11",
     * "vipEndTime": "2020-06-10 09:18:11",
     * "createTime": "2020-06-10 09:18:11",
     * "updateTime": "2020-06-10 22:21:15"
     * }
     */

    /**
     * @api {POST} /api/user/updateUserInfo 修改用户资料
     * @apiName 修改用户资料
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {String} avatar 头像
     * @apiParam {String} name 昵称
     * @apiParam {String} gender 性别  未知：UNKNOWN（默认值）；男：MAN；女：WOMAN
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "12345678947",
     *       "avatar": "12345678947",
     *       "name": "1234",
     *       "gender": "UNKNOWN"
     *     }
     */

    /**
     * @api {POST} /api/user/getUserInfo 用户信息
     * @apiName 用户信息
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "12345678947"
     *     }
     * @apiUse userInfoSuccess
     */
    /**
     * @api {POST} /api/user/getUserInfoByInvitationCode 通过邀请码获取用户信息
     * @apiName 通过邀请码获取用户信息
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "12345678947",
     *       "invitationCode": "123131"
     *     }
     * @apiUse userInfoSuccess
     */

    /**
     * @api {POST} /api/config/vipLevel 获取vip等级信息
     * @apiName 获取vip等级信息
     * @apiGroup 配置
     * @apiSuccess {Int} id
     * @apiSuccess {String} vipName vip等级名称
     * @apiSuccess {String} vipMonthNum vip时长，单位月
     * @apiSuccess {String} vipPrice vip价格（单位元）
     * @apiSuccess {String} vipName 昵称
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *  {
     *     "id": 1,
     *     "vipName": "月度VIP",
     *     "vipMonthNum": 1,
     *     "vipPrice": 10,
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     *  }
     */

    /**
     * @api {POST} /api/user/userVipReport vip付费上报
     * @apiName vip付费上报
     * @apiGroup VIP
     * @apiParam {String} token token
     * @apiParam {String} orderType 订单类型
     * @apiParam {String} orderNo 订单号
     * @apiParam {String} receipt 交易数据
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "orderType": 1,
     *       "orderNo": "1312312312",
     *       "receipt": "eqaweqweqwe"
     *     }
     */
    /**
     * @api {POST} /api/user/userLableList 用户称谓列表
     * @apiName 用户称谓列表
     * @apiGroup 用户
     * @apiSuccess {Int} id
     * @apiSuccess {String} lableName 称谓
     * @apiSuccess {String} lableAlias 称谓别名
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *{
     *     "id": 1,
     *     "lableName": "情侣",
     *     "lableAlias": "LOVERS",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     * }
     */
    /**
     * @api {POST} /api/user/bindUser 绑定用户
     * @apiName 绑定用户
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {String} phone 手机号
     * @apiParam {String} labelName 称谓
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "phone": "17620410531",
     *       "labelName": "情侣"
     *     }
     */
    /**
     * @api {POST} /api/user/unBindUser 解除绑定用户
     * @apiName 解除绑定用户
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {String} bindId 绑定数据id
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "bindId": "1231"
     *     }
     */
    /**
     * @api {POST} /api/user/updateBindUserInfo 修改绑定用户资料（只对自己生效）
     * @apiName 修改绑定用户资料
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {String} bindId 绑定数据id
     * @apiParam {String} avatar 头像
     * @apiParam {String} remark 备注
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "12345678947",
     *       "bindId": "21",
     *       "avatar": "12345678947",
     *       "remark": "Ada"
     *     }
     */
    /**
     * @api {POST} /api/user/getBindUser 获取绑定用户
     * @apiName 获取绑定用户
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf"
     *     }
     * @apiSuccess {Int} id
     * @apiSuccess {String} fromUserId 谁绑定的
     * @apiSuccess {String} toUserId 绑定的谁
     * @apiSuccess {String} labelName 称谓
     * @apiSuccess {String} avatar 头像
     * @apiSuccess {String} phone 手机号
     * @apiSuccess {String} remark 备注
     * @apiSuccess {Double} latitude 纬度
     * @apiSuccess {Double} longitude 经度
     * @apiSuccess {String} address 地址
     * @apiSuccess {Double} distance 距离（单位米）
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *{
     *     "id": 1,
     *     "fromUserId": "1",
     *     "toUserId": "2",
     *     "labelName": "情侣",
     *     "avatar": "https://thirtyfairy.oss-cn-shenzhen.aliyuncs.com/icon_default_avatar.jpg",
     *     "phone": "165431321321",
     *     "latitude": "11.3534534",
     *     "longitude": "144.12311",
     *     "address": "广东省深圳市龙华区牛地铺西区",
     *     "distance": "1000",
     *     "remark": "备注",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     * }
     */
    /**
     * @api {POST} /api/user/userLocationReportList 用户位置批量上报
     * @apiName 用户位置批量上报
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {Object[]} locationLogs 上报数组
     * @apiParam {String} locationLogs.latitude 纬度
     * @apiParam {String} locationLogs.longitude 经度
     * @apiParam {String} locationLogs.address 上报内容
     * @apiParam {String} locationLogs.battery 电量
     * @apiParam {String} locationLogs.networkType 网络类型
     * @apiParam {String="4G","WIFI","5G"} locationLogs.networkType 网络类型；4G / WIFI / 5G
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "locationLogs":[
     *          {
     *              "latitude": 1,
     *              "longitude": 1,
     *              "address": "dasdasd",
     *              "battery": 30,
     *              "networkType": "4G"
     *         }
     *       ]
     *     }
     */
    /**
     * @api {POST} /api/user/userLocationReport 用户位置上报
     * @apiName 用户位置上报
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {String} latitude 纬度
     * @apiParam {String} longitude 经度
     * @apiParam {String} address 上报内容
     * @apiParam {String} battery 电量
     * @apiParam {String="4G","WIFI","5G"} networkType 网络类型；4G / WIFI / 5G
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "latitude": 1,
     *       "longitude": 1,
     *       "address": "dasdasd",
     *       "battery": 30,
     *       "networkType": "4G"
     *     }
     */
    /**
     * @api {POST} /api/user/userOnline 用户在线状态刷新
     * @apiName 用户在线状态刷新
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf"
     *     }
     */
    /**
     * @api {POST} /api/locationLog/locationLogList 获取用户位置
     * @apiName 获取用户位置
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {Integer} userId 用户id
     * @apiParam {String} startTime 开始时间 yyyy-MM-dd
     * @apiParam {String} endTime 结束时间 yyyy-MM-dd
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf",
     *       "userId": "1",
     *       "startTime": "2020-08-29",
     *       "endTime": "2020-08-29"
     *     }
     * @apiSuccess {Int} id
     * @apiSuccess {Int} userId 用户id
     * @apiSuccess {String} address 地址
     * @apiSuccess {Double} longitude 经度
     * @apiSuccess {Double} latitude 纬度
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *{
     *     "id": 1,
     *     "userId": "1",
     *     "address": "2",
     *     "longitude": "2",
     *     "latitude": "1",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     * }
     */
    /**
     * @api {POST} /api/locationLog/clearLocationLog 清除所有位置信息
     * @apiName 清除所有位置信息
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "87d5eb13836247eb92ecdfae09b123cf"
     *     }
     */
    /**
     * @api {POST} /api/hotelbookLog/addLog 酒店记录上报
     * @apiName 酒店记录上报
     * @apiGroup 酒店
     * @apiParam {String} bundleId
     * @apiParam {String} type
     * @apiParam {String} time
     * @apiParam {String} userId
     * @apiParamExample {json} Request-Example:
     *     {
     *       "bundleId": "com.cptech.hotelbook",
     *       "type": 1,
     *       "time": "2020-07-20 18:26:25",
     *       "userId": "a58acd203a577e8eeaae2901cb3779905e9d8741"
     *     }
     */
    /**
     * @api {POST} /api/hotelbookLog/loglist 酒店记录
     * @apiName 酒店记录
     * @apiGroup 酒店
     * @apiParam {String} bundleId
     * @apiParam {String} time
     * @apiParamExample {json} Request-Example:
     *     {
     *       "bundleId": "com.cptech.hotelbook",
     *       "time": "2020-07-20"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *  {
     *     "id": 1,
     *     "bundleId": "com.cptech.hotelbook",
     *     "type": 1,
     *     "time": "2020-07-20 18:26:25",
     *     "userId": "a58acd203a577e8eeaae2901cb3779905e9d8741",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     *  }
     */
    /**
     * @api {POST} /api/sms/sendSms 发送验证码
     * @apiName 发送验证码
     * @apiGroup 验证码
     * @apiParam {String} smsType 短信类型；001:登录
     * @apiParam {String} phone
     * @apiParamExample {json} Request-Example:
     *     {
     *       "smsType": "001",
     *       "phone": "17620410531"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {GET} /api/common/ossSts 阿里ossSts
     * @apiName 阿里ossSts
     * @apiGroup 配置
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {GET} /api/locationLog/sync 同步内存中的定位数据
     * @apiName 同步内存中的定位数据
     * @apiGroup 配置
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {GET} /api/suggestRecord 意见反馈
     * @apiName 意见反馈
     * @apiGroup 配置
     * @apiParam {String} token token
     * @apiParam {String} content 反馈内容
     * @apiParam {String} imgs   反馈图片
     * @apiParam {String="建议","故障","位置问题","其他"} type   反馈类型
     * @apiParam {String} phone   联系电话
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "content": "啊啊所大所",
     *       "imgs": "http://ssadasd"",
     *       "type": "其他"",
     *       "phone": "1231231312"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {GET} /api/user/oneKeyPolice 一键报警
     * @apiName 一键报警
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {Integer} userId 用户id
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "userId": "1231"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {POST} /api/push/pushAccount account方式推送
     * @apiName account方式推送
     * @apiGroup 推送
     * @apiParam {String} token token
     * @apiParam {Integer} userId 用户id
     * @apiParam {String} title 标题
     * @apiParam {String} body 子标题
     * @apiParam {String} extParam 自定义参数，必须json字符串（非必填）
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "userId": "28",
     *       "title": "这里是标题",
     *       "body": "这里是子标题",
     *       "extParam": ""
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     * }
     */
    /**
     * @api {POST} /api/locationLog/userMsgList 用户消息
     * @apiName 用户消息
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312"
     *     }
     * @apiSuccess {Int} id
     * @apiSuccess {Int} toUserId 用户id
     * @apiSuccess {String} content 消息内容
     * @apiSuccess {Int} msgType 消息类型；1：好友提醒
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *{
     *     "id": 1,
     *     "toUserId": "1",
     *     "content": "佩奇222通过微信邀请成为了你的好友，及时关注ta哟",
     *     "msgType": "1",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     * }
     */
    /**
     * @api {POST} /api/user/updateBindUserBatteryWarning 修改电量预警
     * @apiName 修改电量预警
     * @apiGroup 用户
     * @apiParam {String} token token
     * @apiParam {Int} bindId 绑定用户id
     * @apiParam {Int} batteryWarning 低电量提醒；1：提醒，0：不提醒
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "bindId": "1",
     *       "batteryWarning": "1"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     *
     * }
     */
    /**
     * @api {POST} /api/bindUserLocation/list 获取好友提醒地址
     * @apiName 获取好友提醒地址
     * @apiGroup 好友
     * @apiParam {String} token token
     * @apiParam {Int} bindId 好友数据id
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "bindId": 1
     *     }
     * @apiSuccess {Int} id
     * @apiSuccess {String} title
     * @apiSuccess {String} address
     * @apiSuccess {Double} longitude
     * @apiSuccess {Double} latitude
     * @apiUse createAndUpdateTime
     * @apiSuccessExample {json} Request-Example:
     *[{
     *     "id": 1,
     *     "title": "1",
     *     "address": "佩奇222通过微信邀请成为了你的好友，及时关注ta哟",
     *     "longitude": "1",
     *     "latitude": "1",
     *     "createTime": "2020-06-13 00:24:47",
     *     "updateTime": "2020-06-13 00:24:49"
     * }]
     */

    /**
     * @api {POST} /api/bindUserLocation/add 新增好友提醒地址
     * @apiName 新增好友提醒地址
     * @apiGroup 好友
     * @apiParam {String} token token
     * @apiParam {Int} toUserId 绑定好友用户ID
     * @apiParam {Int} bindId 好友数据id
     * @apiParam {String} title 标题
     * @apiParam {String} latitude 纬度
     * @apiParam {String} longitude 经度
     * @apiParam {String} address 地址
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "toUserId": "1",
     *       "bindId": "1",
     *       "title": "1",
     *       "latitude": "11.3534534",
     *       "longitude": "144.12311",
     *       "address": "广东省深圳市龙华区牛地铺西区",
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     *
     * }
     */
    /**
     * @api {POST} /api/bindUserLocation/delete 删除好友提醒地址
     * @apiName 删除好友提醒地址
     * @apiGroup 好友
     * @apiParam {String} token token
     * @apiParam {Int} bindUserLocationId 绑定地址数据id
     * @apiParamExample {json} Request-Example:
     *     {
     *       "token": "1231231312",
     *       "bindUserLocationId": "1"
     *     }
     * @apiSuccessExample {json} Request-Example:
     *{
     *
     * }
     */
    /**
     * @api {POST} /api/common/vipTotal vip统计
     * @apiName vip统计
     * @apiGroup VIP
     * @apiParam {String} startTime 开始时间 yyyy-MM-dd
     * @apiParam {String} endTime 结束时间 yyyy-MM-dd
     * @apiParamExample {json} Request-Example:
     *    {
     *       "startTime": "2020-08-29",
     *       "endTime": "2020-08-29"
     *     }
     * @apiSuccess {Int} total 总升级会员
     * @apiSuccess {Int} totalPrice 总升级金额
     * @apiSuccess {Int} dateTotal 当前查询总升级会员
     * @apiSuccess {Int} dateTotalPrice 当前查询总升级金额
     * @apiSuccess {Int} zhouTotal 当前查询周总升级会员
     * @apiSuccess {Int} zhouTotalPrice 当前查询周总升级金额
     * @apiSuccess {Int} yueTotal 当前查询总月升级会员
     * @apiSuccess {Int} yueTotalPrice 当前查询月总升级金额
     * @apiSuccess {Int} jiTotal 当前查询季度总升级会员
     * @apiSuccess {Int} jiTotalPrice 当前查询季度总升级金额
     * @apiSuccess {Int} nianTotal 当前查询年总升级会员
     * @apiSuccess {Int} nianTotalPrice 当前查询年总升级金额
     * @apiSuccessExample {json} Request-Example:
     *{
     * "total": 14,
     * "totalPrice": 1175,
     * "dateTotal": 5,
     * "dateTotalPrice": 504,
     * "zhouTotal": 1,
     * "zhouTotalPrice": 7,
     * "yueTotal": 2,
     * "yueTotalPrice": 30,
     * "jiTotal": 1,
     * "jiTotalPrice": 168,
     * "nianTotal": 1,
     * "nianTotalPrice": 299
     * }
     */
    /**
     * @api {POST} /api/common/viplogDetails vip开通详情
     * @apiName vip开通详情
     * @apiGroup VIP
     * @apiParam {String} orderType 开通类型
     * @apiParam {String} startTime 开始时间 yyyy-MM-dd
     * @apiParam {String} endTime 结束时间 yyyy-MM-dd
     * @apiParam {Int} page=1 页码
     * @apiParam {Int} pageSize=10 每页数量
     * @apiParamExample {json} Request-Example:
     *    {
     *       "startTime": "2020-08-29",
     *       "endTime": "2020-08-29"
     *     }
     *
     *@apiUse userInfoSuccess
     */
}
